<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Class bmqa::MessageIterator</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqa.html">bmqa</a>      </li>
      <li><a class="el" href="classbmqa_1_1MessageIterator.html">bmqa::MessageIterator</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>bmqa::MessageIterator Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqa::MessageIterator" -->
<p><code>#include &lt;<a class="el" href="bmqa__messageiterator_8h_source.html">bmqa_messageiterator.h</a>&gt;</code></p>

<p><a href="classbmqa_1_1MessageIterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessageIterator.html#ab25f161ea48938f1c622be073b45c202">MessageIterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessageIterator.html#abdbe5d9a7aac3f7949f2d0b78b66ad3b">MessageIterator</a> (const <a class="el" href="classbmqa_1_1MessageIterator.html">MessageIterator</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessageIterator.html#a9d29a3b8eb64085810b6a84cc7a88525">~MessageIterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqa_1_1MessageIterator.html">MessageIterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessageIterator.html#a985f3f960d37bcacd1ff22594795cf5a">operator=</a> (const <a class="el" href="classbmqa_1_1MessageIterator.html">MessageIterator</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessageIterator.html#aebcc19c61a0b788c076b1a2ba5cca6bf">nextMessage</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbmqa_1_1Message.html">Message</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1MessageIterator.html#ac3edf62526982ad45cc7d0bdb1c07478">message</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An iterator providing read-only sequential access to messages contained into a <code>MesssageEvent</code>.</p>
<p>See <a class="el" href="group__bmqa__messageiterator.html">Component bmqa_messageiterator</a> </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab25f161ea48938f1c622be073b45c202"></a><!-- doxytag: member="bmqa::MessageIterator::MessageIterator" ref="ab25f161ea48938f1c622be073b45c202" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::MessageIterator::MessageIterator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default constructor </p>

</div>
</div>
<a class="anchor" id="abdbe5d9a7aac3f7949f2d0b78b66ad3b"></a><!-- doxytag: member="bmqa::MessageIterator::MessageIterator" ref="abdbe5d9a7aac3f7949f2d0b78b66ad3b" args="(const MessageIterator &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::MessageIterator::MessageIterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1MessageIterator.html">MessageIterator</a> &amp;&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9d29a3b8eb64085810b6a84cc7a88525"></a><!-- doxytag: member="bmqa::MessageIterator::~MessageIterator" ref="a9d29a3b8eb64085810b6a84cc7a88525" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::MessageIterator::~MessageIterator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a985f3f960d37bcacd1ff22594795cf5a"></a><!-- doxytag: member="bmqa::MessageIterator::operator=" ref="a985f3f960d37bcacd1ff22594795cf5a" args="(const MessageIterator &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqa_1_1MessageIterator.html">MessageIterator</a>&amp; bmqa::MessageIterator::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1MessageIterator.html">MessageIterator</a> &amp;&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aebcc19c61a0b788c076b1a2ba5cca6bf"></a><!-- doxytag: member="bmqa::MessageIterator::nextMessage" ref="aebcc19c61a0b788c076b1a2ba5cca6bf" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool bmqa::MessageIterator::nextMessage </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Advance the position of the iterator to the next message in the event. Return true if there is a next message and false otherwise. Note that advancing to the next message will invalidate any previously returned <a class="el" href="classbmqa_1_1Message.html">bmqa::Message</a> retrieved from the <code><a class="el" href="classbmqa_1_1MessageIterator.html#ac3edf62526982ad45cc7d0bdb1c07478">message()</a></code> call. </p>

</div>
</div>
<a class="anchor" id="ac3edf62526982ad45cc7d0bdb1c07478"></a><!-- doxytag: member="bmqa::MessageIterator::message" ref="ac3edf62526982ad45cc7d0bdb1c07478" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classbmqa_1_1Message.html">Message</a>&amp; bmqa::MessageIterator::message </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the message to which the iterator is pointing, if any; otherwise return an invalid message. Note that <code>nextMessage</code> must be called before <code>message</code> in order to advance the iterators position to the first message in the event. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bmqa__messageiterator_8h_source.html">bmqa_messageiterator.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:51 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
